/*
 * This file is part of the Sx Framework Library.
 * 
 * Copyright (C) 2013 University of Colorado Denver
 * <min.choi@ucdenver.edu> <shane.transue@ucdenver.edu>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 */
#ifndef SX_DOUBLE_H
#define SX_DOUBLE_H

#include <ostream>

namespace Sx {

/*
 * The Double class provides a set of utility functions that are commonly
 * useful in the context of a complete library. This class provides a localized
 * library of conversion and parsing functions for basic doubleing point types.
 */
class Double {
public:
	Double();
	Double(const Double& f);
	Double(double value);
	Double(float value);
	Double(short value);
	Double(int value);
	Double(long value);
	~Double();

	/*
	 * Sets the value of this double to the provided value.
	 */
	void set(double value);

	/*
	 * Returns the internal double value stored in this Integer.
	 */
	double data() const;

	/*
	 * Allows the interal representation of this Double to be used as a native
	 * double value.
	 */
	operator double () const;

	/*
	 * Returns the maximum possible double value.
	 */
	static Double Max();

	/*
	 * Returns the minimum possible double value.
	 */
	static Double Min();

	/*
	 * Returns the symbolic value of infinity for a Double.
	 */
	static Double Infinity();

	/* Returns an unsigned long conversion of this double. */
	static unsigned long ToUnsignedLong(const Double& d);

	/* Operator Defintions */
	Double operator + (const Double& d);
	Double operator + (double d);
	Double operator - (const Double& d);
	Double operator - (double d);
	Double operator * (const Double& d);
	Double operator * (double d);
	Double operator / (const Double& d);
	Double operator / (double d);
	void operator += (const Double& d);
	void operator += (double d);
	void operator -= (const Double& d);
	void operator -= (double d);
	void operator *= (const Double& d);
	void operator *= (double d);
	void operator /= (const Double& d);
	void operator /= (double d);
	void operator = (const Double& d);
	void operator = (double d);

	bool operator == (const Double& d);
	bool operator != (const Double& d);
	bool operator == (double d);
	bool operator != (double d);
	bool operator <= (const Double & d);
	bool operator <= (double d);
	bool operator >= (const Double & d);
	bool operator >= (double d);
	bool operator < (const Double & d);
	bool operator < (double d);
	bool operator > (const Double & d);
	bool operator > (double d);

	/* Global double addition operator */
	friend Double operator + (double v, const Double& d);
	friend Double operator - (double v, const Double& d);
	friend Double operator * (double v, const Double& d);
	friend Double operator / (double v, const Double& d);

	/* Provides basic stream ouput for the value of this Double. */
	friend std::ostream& operator << (std::ostream& out, const Double& d);

protected:
	double value;
};

}

#endif
